home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / pcboard / gcsnv100.zip / GCSN.DOC (.txt) < prev    next >
Word Document  |  1996-06-04  |  37KB  |  578 lines
  1.  
  2.                            Global Conference ScaN
  3.                                    (GCSN)
  4.  
  5.                                  Version 1.0
  6.                                 By Brian Stix
  7.                      ┬⌐ Copyright 1995-1996 - Brian Stix
  8.  
  9.  
  10.  
  11.      A global search/scan PPE for (L)ocate, (N)ew Scan, and (Z)ippy Scan
  12.                               Table of Contents
  13.  
  14.      I. Introduction
  15.     II. Features
  16.    III. Installation
  17.     IV. Configuration Files
  18.      V. Command Line Options
  19.     VI. Miscellaneous
  20.    VII. Bugs/Limitations/Features To Be
  21.   VIII. Contacting The Author/Technical Support/Getting Updates/Registering
  22.     IX. Legal Issues
  23.  
  24.  
  25. Note:
  26.       This documentation was originally written in Microsoft Word v7.0.  If
  27. there are problems with spacing and the like in the text version, youΓÇÖll
  28. have to take it up with Microsoft and their conversion (or lack there of).
  29. Sorry, but I donΓÇÖt have the time or patience to reformat the text version,
  30. nor should I have to.
  31.  
  32. Introduction
  33.  
  34.  
  35.       PCBoard is great BBS software.  Some people consider it to be as
  36. complete as they need it to be, and others (myself included) feel that it
  37. lacks some features (one of the main reasons Clark Development created
  38. PPL).
  39.  
  40.       One of the problems I had on my BBS was supporting file areas for
  41. multiple operating systems (i.e. DOS, Windows, Windows 95, OS/2, Windows
  42. NT, UNIX, etc..).  I didnΓÇÖt want to throw everything into one conference,
  43. so my solution was to give each operating system its own conference.  While
  44. that solved one problem, it created several new ones.  Among them, there
  45. was no way to ΓÇ£automaticallyΓÇ¥ do the following across conferences:
  46.  
  47.       n Locate a filename
  48.       n New file scan
  49.       n Zippy text scan
  50.  
  51.       I could only find one multiple conference type of scanner that even
  52. attempted to do the above:  LNZ.  It scanned multiple conferences just
  53. fine, but it lacked a lot of functionality that I was looking for.  So I
  54. decided to do something about thisΓǪ
  55.  
  56.       Before I go any further, here is the license agreement and
  57. warranty/disclaimer.
  58.  
  59.  
  60. License
  61.  
  62.       You are free to use GCSN for 30 (thirty) days in order to evaluate
  63. the product.  If after 30 (thirty) days you feel that GCSN is of us to you,
  64. you must register it.  Once you have registered GCSN, you may use it only
  65. on ONE BBS system, though the BBS may run on more than one computer.  You
  66. may use it on as many nodes of ONE BBS system as you like.  If you run more
  67. than one BBS (i.e. a home BBS and a work BBS, or two BBSes at home) you
  68. must register GCSN for each different BBS that it runs on.
  69.  
  70. Warranty/Disclaimer
  71.  
  72.       There is no expressed or implied warranty associated with GCSN.  I am
  73. not responsible if anything goes wrong whether directly or indirectly
  74. related to GCSN, whether it be hardware crashes, lost data, or anything you
  75. could ever think of.
  76.  
  77. Features
  78.  
  79.  
  80.       Global Conference ScaN (GCSN) has many features, some of which are:
  81.  
  82.       n Consistency with PCBoard conventions including:
  83.                n PCBoard file naming conventions (i.e. graphics & RIP)
  84.                n Multiple language support
  85.                n Use of existing PCBoard options for scanning to decrease
  86.                  users learning curve
  87.                n Use of PCBoard help file format
  88.                n Use of PCBoard style prompts for a seamless interface
  89.  
  90.  
  91.       n Extensive control over scanning/searching
  92.       n Sysop configurable prompts
  93.       n Sysop configurable commands
  94.       n Logging to callerΓÇÖs log
  95.  
  96.  
  97. Installation
  98.  
  99.  
  100.       To do a basic install of GCSN:
  101.  
  102.      1. Create a directory where you wish GCSN to reside.  It is
  103.         recommended that you create a separate directory for GCSN.  GCSN
  104.         requires directories off of its home directory (i.e.
  105.         ΓÇ£c:\pcb\gcsnΓÇ¥).
  106.      2. Unzip the GCSN zip file to the directory you created in step #1.
  107.         IMPORTANT:  use the ΓÇ£-dΓÇ¥ parameter to unzip the sub-directories
  108.         (e.g. ΓÇ£pkunzip -d gcsnv10 c:\pcb\gcsnΓÇ¥)
  109.      3. The GCSN directory structure looks like this:
  110.            [ GCSN root ]
  111.                  [ cfgfiles ]
  112.                  [ helpfile ]
  113.      4. Copy all of the files in the helpfile directory to the PCBoard help
  114.         file directory (usually <drive>:\pcb\help)
  115.      5. Run PCBoardΓÇÖs PCBSetup and do the following:
  116.             n Select ΓÇ£B File LocationsΓÇ¥ from the menu.
  117.             n Select ΓÇ£B Configuration FilesΓÇ¥ from the menu.
  118.             n Go down to ΓÇ£Name/Loc of Default CMD.LST fileΓÇ¥ and hit F2 to
  119.               edit it.
  120.             n Insert three commands, lg, ng, and zg.  For the ΓÇ£PPE/MNU File
  121.               Specification -or- Keystroke Substitution,ΓÇ¥ put the full
  122.               file/path of the GCSN.PPE. (e.g. ΓÇ£c:\pcb\gcsn\gcsn.ppeΓÇ¥).
  123.               Refer to the PCBoard manual for further details on how to add
  124.               new commands and all of the various settings.
  125.  
  126.  
  127.                  The entries should look something similar to this:
  128.  
  129.  
  130.                  Command    Sec   Minute     Use   PPE/MNU File
  131.            SpecificationΓǪ
  132.                  LG         21    0     0    \pcb\gcsn\gcsn.ppe
  133.                  NG         21    0     0    \pcb\gcsn\gcsn.ppe
  134.                  ZG         21    0     0    \pcb\gcsn\gcsn.ppe
  135.  
  136.  
  137.       This is all that is required to get GCSN up and running on most
  138. PCBoard BBSes.  For more complex BBSes or a sysop that  wants to change the
  139. default settings of GCSN, read on.
  140.  
  141.       GCSN has all of its configuration files in the cfgfiles directory off
  142. of the GCSN home directory.  When GCSN is run, it automatically figures out
  143. which configuration file to use, based on the PCBoard file naming
  144. convention.  This includes the ΓÇÿgΓÇÖ and ΓÇÿrΓÇÖ parameters for graphics and rip
  145. script mode, and also the language extension.  Refer to the PCBoard manual
  146. for further details on how PCBoardΓÇÖs files are named.  The rest of the
  147. configuration of GCSN resides in the configuration files.  The next
  148. chapter, Configuration Files, explains the configuration file layout and
  149. its settings.
  150.  
  151.  
  152.  
  153. Configuration Files
  154.  
  155.  
  156.       Each GCSN configuration file has 11 lines that pertain to the
  157. configuration of GCSN.  The rest are comments/notes (ΓÇ£short descriptionΓÇ¥)
  158. so that the sysop doesnΓÇÖt have to fumble with this manual and the
  159. configuration file.
  160.  
  161.       Line #1
  162.             Short description:  ΓÇ£Configuration file header.  Must not be
  163. changed!ΓÇ¥
  164.             Default value:  ΓÇ£Global Conference ScaNΓÇ¥
  165.  
  166.                  This line should never be changed!  This is just used as a
  167.            simple safeguard for GCSN to be sure that this is actually a
  168.            GCSN configuration file.  It is not a foolproof safeguard
  169.            (nothing is completely foolproof), but it is better than
  170.            nothing.  If GCSN finds something other than the default value,
  171.            it will display an error message to the user and write an error
  172.            into the sysop log.
  173.  
  174.  
  175.       Line #2
  176.             Short description:  ΓÇ£Command in PCBoard to invoke the global
  177. (L)ocate functionΓÇ¥
  178.             Default value:  ΓÇ£lgΓÇ¥
  179.  
  180.  
  181.                  This is the command used to invoke the global (L)ocate
  182.            function.  GCSN compares the command issued to get to the PPE
  183.            from PCBoard with this value.  If they match, then it knows to
  184.            do a global (L)ocate.
  185.  
  186.  
  187.       Line #3
  188.             Short description:  ΓÇ£Global (L)ocate promptΓÇ¥
  189.             Default values:
  190.                  Non-graphic:  ΓÇ£(Global Locate) Search conference?ΓÇ¥
  191.                  Graphic:  ΓÇ£@X08(@X0BGlobal Locate@X08) @X03Search
  192.                  conference@X08?ΓÇ¥
  193.                  Rip script:  ΓÇ£ΓÇ¥
  194.  
  195.  
  196.                  This is the prompt that is displayed when the (L)ocate
  197.            function needs to ask the user if he/she wishes to search this
  198.            conference or not.  This follows PCBoard convention in that a
  199.            PPE (ΓÇ£!ΓÇ¥ as the first character) or a file may be displayed (ΓÇ£ΓÇ¥
  200.            as the first character). Refer to the PCBoard manual for further
  201.            details on the option for prompts.
  202.  
  203.  
  204.       Line #4
  205.             Short description:  ΓÇ£Color for the ΓÇ£( )?ΓÇ¥ part of the (L)ocate
  206. prompt
  207.             Default values:
  208.                  Non-graphic:  <blank>
  209.                  Graphic:  ΓÇ£@X08ΓÇ¥
  210.                  Rip script:  ΓÇ£ΓÇ¥
  211.  
  212.                  This is the color that the ΓÇ£( )?ΓÇ¥ part of the prompt that
  213.            comes after the (L)ocate prompt.  You cannot just put a color
  214.            code at the end of the (L)ocate prompt as you would in a PCBTEXT
  215.            entry because GCSN uses two separate functions to display the
  216.            complete (L)ocate prompt.
  217.  
  218.       Line #5
  219.            Short description:  ΓÇ£Command in PCBoard to invoke the global
  220.            (N)ew scan functionΓÇ¥
  221.             Default value:  ΓÇ£ngΓÇ¥
  222.  
  223.                  This is the command used to invoke the global (N)ew scan
  224.            prompt.  GCSN compares the command issued to get the PPE from
  225.            PCBoard with this value.  If they match, then it knows to do a
  226.            global (N)ew scan.
  227.  
  228.  
  229.       Line #6
  230.             Short description:  ΓÇ£Global (N)ew scan promptΓÇ¥
  231.             Default values:
  232.                  Non-graphic:  ΓÇ£(Global New Scan) Scan conference?ΓÇ¥
  233.                  Graphic:  ΓÇ£@X08(@X0BGlobal New Scan@X08) @X03Scan
  234.                  conference@X08?ΓÇ¥
  235.                  Rip script:  ΓÇ£ΓÇ¥
  236.  
  237.                  This is the prompt that is displayed when the (N)ew scan
  238.            function needs to ask the user if he/she wishes to scan this
  239.            conference or not.  This follows PCBoard convention in that a
  240.            PPE (ΓÇ£!ΓÇ¥ as the first character) or a file may be displayed (ΓÇ£ΓÇ¥
  241.            as the first character). Refer to the PCBoard manual for further
  242.            details on the option for prompts.
  243.  
  244.  
  245.       Line #7
  246.             Short description:  ΓÇ£Color for the ΓÇ£( )?ΓÇ¥ part of the (N)ew
  247. scan promptΓÇ¥
  248.             Default values:
  249.                  Non-graphic:  <blank>
  250.                  Graphic:  ΓÇ£@X08ΓÇ¥
  251.                  Rip script:
  252.  
  253.                  This is the color that the ΓÇ£( )?ΓÇ¥ part of the prompt that
  254.            comes after the (L)ocate prompt.  You cannot just put a color
  255.            code at the end of the (L)ocate prompt, as you would in a
  256.            PCBTEXT entry because GCSN uses two separate functions to
  257.            display the complete (L)ocate prompt.
  258.  
  259.  
  260.       Line #8
  261.            Short description:  ΓÇ£Command in PCBoard to invoke the global
  262.            (Z)ippy scan functionΓÇ¥
  263.             Default value:  ΓÇ£zgΓÇ¥
  264.  
  265.                  This is the command used to invoke the global (Z)ippy scan
  266.            prompt.  GCSN compares the command issued to get the PPE from
  267.            PCBoard with this value.  If they match, then it knows to do a
  268.            global (Z)ippy scan.
  269.  
  270.  
  271.       Line #9
  272.             Short description:  ΓÇ£Global (Z)ippy scan promptΓÇ¥
  273.             Default values:
  274.                  Non-graphic:  ΓÇ£(Global Zippy Scan) Scan conference?ΓÇ¥
  275.                  Graphic:  ΓÇ£@X08(@X0BGlobal Zippy Scan@X08) @X03Scan
  276.                  conference@X08?ΓÇ¥
  277.                  Rip script:  ΓÇ£ΓÇ¥
  278.  
  279.                  This is the prompt that is displayed when the (Z)ippy scan
  280.            function needs to ask the user if he/she wishes to scan this
  281.            conference or not.  This follows PCBoard convention in that a
  282.            PPE (ΓÇ£!ΓÇ¥ as the first character) or a file may be displayed (ΓÇ£ΓÇ¥
  283.            as the first character). Refer to the PCBoard manual for further
  284.            details on the option for prompts.
  285.  
  286.  
  287.       Line #10
  288.             Short description:  ΓÇ£Color for the ΓÇ£( )?ΓÇ¥ part of the global
  289. (Z)ippy scan prompt
  290.             Default values:
  291.                  Non-graphic:  <blank>
  292.                  Graphic:  ΓÇ£@X08ΓÇ¥
  293.                  Rip script:
  294.  
  295.                  This is the color that the ΓÇ£( )?ΓÇ¥ part of the prompt that
  296.            comes after the (L)ocate prompt.  You cannot just put a color
  297.            code at the end of the (L)ocate prompt, as you would in a
  298.            PCBTEXT entry because GCSN uses two separate functions to
  299.            display the complete (L)ocate prompt.
  300.  
  301.  
  302.       Line #11
  303.             Short description:  ΓÇ£Clear screen commandΓÇ¥
  304.             Default values:
  305.                  Non-graphic:  <blank>
  306.                  Graphic:  ΓÇ£@X07@CLS@ΓÇ¥
  307.                  Rip script:
  308.  
  309.                  This is the command that GCSN with use to clear the
  310. screen.
  311.  
  312. Command Line Options
  313.  
  314.  
  315.       All command line options are case-insensitive (i.e. 'A' and 'a' are
  316. the same).  The default values of these are determined by the sysop in the
  317. configuration file (see Configuration File Options).
  318.  
  319.       ΓÇÿverΓÇÖ - Version/Registration
  320.                  This will display the current running version of GCSN,
  321. along with the               registration information.
  322.  
  323.             Scope:  All global scans/searches
  324.  
  325.  
  326.       ΓÇÿnsΓÇÖ - Non-Stop
  327.  
  328.                  Determines whether or not there will be a prompt allowing
  329.            the user to flag files at the end of a scan/search in a
  330.            conference and also sends an 'ns' parameter to PCBoard itself
  331.            when issuing the scan/search.
  332.  
  333.  
  334.            Default:  Not toggled.
  335.            Scope:  All global scans/searches.
  336.            Filter:  Passed onto PCBoard.  Directly used by GCSN.
  337.  
  338.  
  339.       'p' - Pause
  340.       'np' - No Pause
  341.  
  342.                  Determines whether or not there will be a prompt asking the
  343.            user whether or not to scan/search this conference.
  344.  
  345.  
  346.            Default:  ΓÇÿpΓÇÖ - Pause
  347.            Scope:  All global scans/searches.
  348.            Filter:  Not passed onto PCBoard.
  349.  
  350.  
  351.       'fp' - Filename Pause
  352.       ΓÇÿnfp' - No Filename Pause
  353.  
  354.                  Determines whether or not the user will receive a prompt in
  355.            each conference asking for a new filename to use for locating a
  356.            filename.
  357.  
  358.  
  359.            Default:  ΓÇÿnfpΓÇÖ - No Filename Pause
  360.            Scope:  Global (L)ocate only.
  361.            Filter:  Not passed onto PCBoard.
  362.  
  363.  
  364.       'dp' - Date Pause
  365.       'ndp' - No Date Pause
  366.  
  367.                  Determines whether or not the user will receive a prompt in
  368.            each conference asking for a new date to scan by.
  369.  
  370.  
  371.            Default:  ΓÇÿndpΓÇÖ - No Date Pause
  372.            Scope:  Global (N)ew Scan only.
  373.            Filter:  Not passed onto PCBoard.
  374.  
  375.  
  376.       'tp' - Text Pause
  377.       'ntp' - No Text Pause
  378.  
  379.                  Determines whether or not the user will receive a prompt in
  380.            each conference asking for new text to use for scanning.
  381.  
  382.  
  383.            Default:  ΓÇÿntpΓÇÖ - No Text Pause
  384.            Scope:  Global (Z)ippy Scan only.
  385.            Filter:  Not passed onto PCBoard.
  386.  
  387.  
  388.       'stp' - Scan Type Pause
  389.       'nstp' - No Scan Type Pause
  390.  
  391.                  Determines whether or not the user will receive a prompt in
  392.            each conference asking the directories to scan/search (i.e.
  393.            #,(a)ll,(u)pload).
  394.  
  395.  
  396.            Default:  ΓÇÿnstpΓÇÖ - No Scan Type Pause
  397.            Scope:  All global scans/searches.
  398.            Filter:  Not passed onto PCBoard.
  399.  
  400.  
  401.       'a' - All
  402.  
  403.                  Forces scan/search to do an (a)ll directory scan/search.
  404.            Overrides 'stp'/'nstp' command line options.  This follows
  405.            PCBoard convention.
  406.  
  407.  
  408.            Default:  Prompt given.
  409.            Scope:  All global scans/searches.
  410.            Filtering status:  Passed onto PCBoard.  Not directly used by
  411.            GCSN.
  412.  
  413.  
  414.       ΓÇÿu' - Upload
  415.  
  416.                  Forces scan/search to do an (u)pload directory scan/search.
  417.             Overrides 'stp'/'nstp' command line options.  This follows
  418.            PCBoard convention.
  419.  
  420.  
  421.            Default:  Prompt given.
  422.            Scope:  All global scans/searches.
  423.            Filtering status:  Passed onto PCBoard,.  Not directly used by
  424.            GCSN.
  425.  
  426.  
  427.       <#####> - Conference Number
  428.  
  429.                  Tells scan/search to only scan/search conferences
  430.            specified.
  431.  
  432.  
  433.            Default:  All conferences.
  434.            Scope:  All global scans/searches.
  435.            Filtering status:  Not passed onto PCBoard.
  436.  
  437.  
  438.       <MMDDYY> - Date
  439.  
  440.                  Tells scan to use the specified date for a new scan.  This
  441.            follows PCBoard date format convention for a new scan.
  442.  
  443.  
  444.            Default:  Prompt given.
  445.            Scope:  Global (N)ew scan only.
  446.            Filtering status:  Passed onto PCBoard.  Not directly used by
  447.            GCSN, except for validation purposes.
  448. Miscellaneous
  449.  
  450.  
  451.       GCSN will log to the callerΓÇÖs log.  It logs the following:
  452.             n The command used to execute GCSN and the function associated
  453.               with that command.
  454.             n Unknown command(s)
  455.             n Fatal errors
  456.  
  457.       Currently that is all the entries that GCSN will log.  In the future
  458. I will add additional logging to the caller log, along with logging options
  459. in a configuration file.
  460.  
  461. Bugs/Limitations/Features To Be
  462.  
  463.  
  464.  
  465. Known Bugs:
  466.  
  467.       n None currently known
  468.  
  469.  
  470.  
  471.  
  472. Known Limitations
  473.  
  474.       n There is no way to specify what directories to scan on the command
  475.         line.  GCSN uses the numbers on the command line as the conferences
  476.         to scan.  Stock PCBoard searches/scans use this as the directories
  477.         to scan.
  478.       n If GCSN is set to prompt for flagging files and there are no files
  479.         to tag (e.g. a (N)ew scan of a conference where there are no new
  480.         files, or a (L)ocate that didnΓÇÖt turn up any files in its search of
  481.         a conference), there will still be a prompt for flagging files
  482.         displayed.  So far, I havenΓÇÖt been able to find a way to tell if
  483.         there was something found for a given search/scan.
  484.  
  485. Features To Be:
  486.       n Pre-made RIP script configuration files
  487.       n Pre-made configuration files in languages other than English
  488.       n Documentation in languages other than English
  489.       n Log parameter errors to callerΓÇÖs log
  490.       n Logging options in configuration files
  491.       n User configuration
  492.       n I forgot the restΓǪ
  493.  
  494.  
  495.       If anyone has any ideas, found bugs (ugh!), or found limitations with
  496. GCSN, please contact me!!!  Yes, this means you too.  I want all the input
  497. I can get, in order to improve GCSN.  If anyone is willing to help convert
  498. documentation and/or configuration files to another language, please
  499. contact me!
  500. Contacting The Author/Technical Support/Getting Updates/Registering
  501.  
  502.  
  503.  
  504. Contacting The Author/Technical Support
  505.  
  506. I can be contacted and give technical support the following ways:
  507.  
  508.       n Schwarzwaelder Schloss BBS (recommended):
  509.       (415) 591-9207
  510.       n Internet mail (recommended):
  511.       stickman@netcom.com
  512.       n Salt Air BBS (not recommended, I donΓÇÖt call that often)
  513.       n Snail mail (please avoid, unless there is no other way):
  514.            Brian Stix
  515.            P.O. Box 538
  516.            San Carlos, California
  517.            94070-0538
  518.            USA
  519.  
  520.  
  521. Getting Updates
  522.  
  523. Updates can be gotten the following ways:
  524.  
  525.       n Schwarzwaelder Schloss BBS (recommended)
  526.       n Salt Air BBS
  527.       n Internet mail (obviously you have tell me to send it via net mail
  528.         first!)
  529.       n Snail mail (obviously you have tell me if you want me to send out a
  530.         disk with GCSN on it (duh!), donΓÇÖt assume it happens magically.
  531.         There will also be a small fee for disk and shipping costs)
  532.  
  533.  
  534.  
  535.  
  536. Registering
  537.  
  538. The only way, unfortunately, to register GCSN is via snail mail.  The
  539. registration fee for non-commercial use is $10 (ten).  The registration fee
  540. for commercial use is $20 (twenty).  You will receive your own personally
  541. registered copy of GCSN.  Remember, GCSN is NOT FREE.  Fill out the
  542. register.txt file and send payment to:
  543.  
  544.       Brian Stix
  545.       P.O. Box 538
  546.       San Carlos, California
  547.       94070-0538
  548.       USA
  549.  
  550. Make check or money order payable to Brian Stix.  Do NOT send cash.  Do NOT
  551. send anything other than funds in U.S. dollars.
  552.  
  553. After I have received your registration, you can receive your registered
  554. copy of GCSN the following ways:
  555.       n Schwarzwaelder Schloss BBS
  556.       n Internet mail
  557.       n Snail mail on disk
  558. Legal Issues
  559.  
  560.       I stated this twice to make sure everyone read it. (
  561.  
  562. License
  563.  
  564.       You are free to use GCSN for 30 (thirty) days in order to evaluate
  565. the product.  If after 30 (thirty) days you feel that GCSN is of us to you,
  566. you must register it.  Once you have registered GCSN, you may use it only
  567. on ONE BBS system, though the BBS may run on more than one computer.  You
  568. may use it on as many nodes of ONE BBS system as you like.  If you run more
  569. than one BBS (i.e. a home BBS and a work BBS, or two BBSes at home) you
  570. must register GCSN for each different BBS that it runs on.
  571.  
  572. Warranty/Disclaimer
  573.  
  574.       There is no expressed or implied warranty associated with GCSN.  I am
  575. not responsible if anything goes wrong whether directly or indirectly
  576. related to GCSN, whether it be hardware crashes, lost data, or anything you
  577. could ever think of.
  578.